<!-- HTML header for doxygen 1.8.13-->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.9.2"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Connectivity Middleware Utilities Library: Network helper functions</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen_style.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><a href="http://www.cypress.com/"><img alt="Logo" src="cypress_logo.png"/></a></td>
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">Connectivity Middleware Utilities Library</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.2 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search",'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(document).ready(function(){initNavTree('group__group__nwhelper__func.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div class="header">
  <div class="summary">
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle"><div class="title">Network helper functions<div class="ingroups"><a class="el" href="group__group__utils.html">Common middleware utilities</a> &raquo; <a class="el" href="group__nwhelper__utils.html">Network helper utilities</a></div></div></div>
</div><!--header-->
<div class="contents">
<a name="details" id="details"></a><h2 class="groupheader">General Description</h2>
<p >This is a collection of network helper functions which would be used by various Cypress Middleware libraries. </p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:gad2beee045469986e9af0f3e98cc2593a"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__nwhelper__func.html#gad2beee045469986e9af0f3e98cc2593a">cy_nw_ip_initialize_status_change_callback</a> (<a class="el" href="structcy__nw__ip__status__change__callback__t.html">cy_nw_ip_status_change_callback_t</a> *info, <a class="el" href="group__group__nwhelper__structures.html#ga08bb004725176839034bec5172b3efb2">cy_nw_ip_status_change_callback_func_t</a> *cbf, void *arg)</td></tr>
<tr class="memdesc:gad2beee045469986e9af0f3e98cc2593a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initialize status change callback.  <a href="group__group__nwhelper__func.html#gad2beee045469986e9af0f3e98cc2593a">More...</a><br /></td></tr>
<tr class="separator:gad2beee045469986e9af0f3e98cc2593a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gab6bb3743e63a62a560f600a49d17f4e8"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__nwhelper__func.html#gab6bb3743e63a62a560f600a49d17f4e8">cy_nw_ip_get_ipv4_address</a> (cy_nw_ip_interface_t iface, <a class="el" href="structcy__nw__ip__address__t.html">cy_nw_ip_address_t</a> *addr)</td></tr>
<tr class="memdesc:gab6bb3743e63a62a560f600a49d17f4e8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Retrieves the IPv4 address for an interface.  <a href="group__group__nwhelper__func.html#gab6bb3743e63a62a560f600a49d17f4e8">More...</a><br /></td></tr>
<tr class="separator:gab6bb3743e63a62a560f600a49d17f4e8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gac064ce1afc6b5f07402fdd0bbfb03073"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__nwhelper__func.html#gac064ce1afc6b5f07402fdd0bbfb03073">cy_nw_str_to_ipv4</a> (const char *ip_str, <a class="el" href="structcy__nw__ip__address__t.html">cy_nw_ip_address_t</a> *address)</td></tr>
<tr class="memdesc:gac064ce1afc6b5f07402fdd0bbfb03073"><td class="mdescLeft">&#160;</td><td class="mdescRight">Convert IPv4 string to an IP address structure.  <a href="group__group__nwhelper__func.html#gac064ce1afc6b5f07402fdd0bbfb03073">More...</a><br /></td></tr>
<tr class="separator:gac064ce1afc6b5f07402fdd0bbfb03073"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga8f71bcd9fe077fb6eaad2e6c2794bd7e"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__nwhelper__func.html#ga8f71bcd9fe077fb6eaad2e6c2794bd7e">cy_nw_ip_register_status_change_callback</a> (cy_nw_ip_interface_t iface, <a class="el" href="structcy__nw__ip__status__change__callback__t.html">cy_nw_ip_status_change_callback_t</a> *info)</td></tr>
<tr class="memdesc:ga8f71bcd9fe077fb6eaad2e6c2794bd7e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Registers for callback function to be invoked during IP status change.  <a href="group__group__nwhelper__func.html#ga8f71bcd9fe077fb6eaad2e6c2794bd7e">More...</a><br /></td></tr>
<tr class="separator:ga8f71bcd9fe077fb6eaad2e6c2794bd7e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga7219dc7312b40ea0d047f4a44dad32a4"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__nwhelper__func.html#ga7219dc7312b40ea0d047f4a44dad32a4">cy_nw_ip_unregister_status_change_callback</a> (cy_nw_ip_interface_t iface, <a class="el" href="structcy__nw__ip__status__change__callback__t.html">cy_nw_ip_status_change_callback_t</a> *info)</td></tr>
<tr class="memdesc:ga7219dc7312b40ea0d047f4a44dad32a4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Un-registers IP status change callback.  <a href="group__group__nwhelper__func.html#ga7219dc7312b40ea0d047f4a44dad32a4">More...</a><br /></td></tr>
<tr class="separator:ga7219dc7312b40ea0d047f4a44dad32a4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga6e28295152dd34e6d4474d51b73f2ef6"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__nwhelper__func.html#ga6e28295152dd34e6d4474d51b73f2ef6">cy_nw_host_arp_cache_clear</a> (cy_nw_ip_interface_t iface)</td></tr>
<tr class="memdesc:ga6e28295152dd34e6d4474d51b73f2ef6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Clears the ARP cache for the interface NOTE: in LwIP, we need the netif (NetworkInterface) to do things, we can find using wifi interface.  <a href="group__group__nwhelper__func.html#ga6e28295152dd34e6d4474d51b73f2ef6">More...</a><br /></td></tr>
<tr class="separator:ga6e28295152dd34e6d4474d51b73f2ef6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga0366c24466017d402f414fda93c992b4"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__nwhelper__func.html#ga0366c24466017d402f414fda93c992b4">cy_nw_host_arp_cache_get_list</a> (cy_nw_ip_interface_t iface, <a class="el" href="structcy__nw__arp__cache__entry__t.html">cy_nw_arp_cache_entry_t</a> *list, uint32_t count, uint32_t *filled)</td></tr>
<tr class="memdesc:ga0366c24466017d402f414fda93c992b4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the ARP cache list for the interface.  <a href="group__group__nwhelper__func.html#ga0366c24466017d402f414fda93c992b4">More...</a><br /></td></tr>
<tr class="separator:ga0366c24466017d402f414fda93c992b4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga85585d772b32c42db4c6c9ae82f1c5db"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__nwhelper__func.html#ga85585d772b32c42db4c6c9ae82f1c5db">cy_nw_host_send_arp_request</a> (cy_nw_ip_interface_t iface, const char *ip_string)</td></tr>
<tr class="memdesc:ga85585d772b32c42db4c6c9ae82f1c5db"><td class="mdescLeft">&#160;</td><td class="mdescRight">Send ARP request NOTE: in LwIP, we need the netif (NetworkInterface) to do things, we can find using wifi interface.  <a href="group__group__nwhelper__func.html#ga85585d772b32c42db4c6c9ae82f1c5db">More...</a><br /></td></tr>
<tr class="separator:ga85585d772b32c42db4c6c9ae82f1c5db"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga8cec7b3315382e02208ba77a14733d8c"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__nwhelper__func.html#ga8cec7b3315382e02208ba77a14733d8c">cy_nw_get_time</a> (void)</td></tr>
<tr class="memdesc:ga8cec7b3315382e02208ba77a14733d8c"><td class="mdescLeft">&#160;</td><td class="mdescRight">GET time in milliseconds.  <a href="group__group__nwhelper__func.html#ga8cec7b3315382e02208ba77a14733d8c">More...</a><br /></td></tr>
<tr class="separator:ga8cec7b3315382e02208ba77a14733d8c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga4a490647cb8388c5c00eff6e90e31f67"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__nwhelper__func.html#ga4a490647cb8388c5c00eff6e90e31f67">cy_nw_aton</a> (const char *char_ptr, <a class="el" href="structcy__nw__ip__address__t.html">cy_nw_ip_address_t</a> *addr)</td></tr>
<tr class="memdesc:ga4a490647cb8388c5c00eff6e90e31f67"><td class="mdescLeft">&#160;</td><td class="mdescRight">GET IPv4 address in decimal notation.  <a href="group__group__nwhelper__func.html#ga4a490647cb8388c5c00eff6e90e31f67">More...</a><br /></td></tr>
<tr class="separator:ga4a490647cb8388c5c00eff6e90e31f67"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga6e1d17b795035ddae44eef8934cd5596"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__nwhelper__func.html#ga6e1d17b795035ddae44eef8934cd5596">cy_nw_aton_ipv6</a> (const char *char_ptr, <a class="el" href="structcy__nw__ip__address__t.html">cy_nw_ip_address_t</a> *addr)</td></tr>
<tr class="memdesc:ga6e1d17b795035ddae44eef8934cd5596"><td class="mdescLeft">&#160;</td><td class="mdescRight">GET IPv6 address in decimal notation.  <a href="group__group__nwhelper__func.html#ga6e1d17b795035ddae44eef8934cd5596">More...</a><br /></td></tr>
<tr class="separator:ga6e1d17b795035ddae44eef8934cd5596"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga6c674d16fdb3bd66e42907e164f9060b"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__nwhelper__func.html#ga6c674d16fdb3bd66e42907e164f9060b">cy_nw_ntoa</a> (<a class="el" href="structcy__nw__ip__address__t.html">cy_nw_ip_address_t</a> *addr, char *ip_str)</td></tr>
<tr class="memdesc:ga6c674d16fdb3bd66e42907e164f9060b"><td class="mdescLeft">&#160;</td><td class="mdescRight">GET IPv4 address in string format.  <a href="group__group__nwhelper__func.html#ga6c674d16fdb3bd66e42907e164f9060b">More...</a><br /></td></tr>
<tr class="separator:ga6c674d16fdb3bd66e42907e164f9060b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga8e1203cce5908ff0dc2fe585097925fc"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__nwhelper__func.html#ga8e1203cce5908ff0dc2fe585097925fc">cy_nw_ntoa_ipv6</a> (<a class="el" href="structcy__nw__ip__address__t.html">cy_nw_ip_address_t</a> *addr, char *ip_str)</td></tr>
<tr class="memdesc:ga8e1203cce5908ff0dc2fe585097925fc"><td class="mdescLeft">&#160;</td><td class="mdescRight">GET IPv6 address in string format.  <a href="group__group__nwhelper__func.html#ga8e1203cce5908ff0dc2fe585097925fc">More...</a><br /></td></tr>
<tr class="separator:ga8e1203cce5908ff0dc2fe585097925fc"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Function Documentation</h2>
<a id="gad2beee045469986e9af0f3e98cc2593a" name="gad2beee045469986e9af0f3e98cc2593a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gad2beee045469986e9af0f3e98cc2593a">&#9670;&nbsp;</a></span>cy_nw_ip_initialize_status_change_callback()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void cy_nw_ip_initialize_status_change_callback </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structcy__nw__ip__status__change__callback__t.html">cy_nw_ip_status_change_callback_t</a> *&#160;</td>
          <td class="paramname"><em>info</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="group__group__nwhelper__structures.html#ga08bb004725176839034bec5172b3efb2">cy_nw_ip_status_change_callback_func_t</a> *&#160;</td>
          <td class="paramname"><em>cbf</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">void *&#160;</td>
          <td class="paramname"><em>arg</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Initialize status change callback. </p>
<p >Initialize <a class="el" href="structcy__nw__ip__status__change__callback__t.html">cy_nw_ip_status_change_callback_t</a> instead of directly manipulating the callback struct.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in,out]</td><td class="paramname">info</td><td>: Pointer to network IP status change callback information structure which would be filled upon return </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">cbf</td><td>: Pointer to callback function to be invoked during network status change </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">arg</td><td>: User data object to be sent sent in the callback function</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>none </dd></dl>

</div>
</div>
<a id="gab6bb3743e63a62a560f600a49d17f4e8" name="gab6bb3743e63a62a560f600a49d17f4e8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gab6bb3743e63a62a560f600a49d17f4e8">&#9670;&nbsp;</a></span>cy_nw_ip_get_ipv4_address()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool cy_nw_ip_get_ipv4_address </td>
          <td>(</td>
          <td class="paramtype">cy_nw_ip_interface_t&#160;</td>
          <td class="paramname"><em>iface</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="structcy__nw__ip__address__t.html">cy_nw_ip_address_t</a> *&#160;</td>
          <td class="paramname"><em>addr</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Retrieves the IPv4 address for an interface. </p>
<p >Retrieves the IPv4 address for an interface (AP or STA) if it exists.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">iface</td><td>: Pointer to network interface object </td></tr>
    <tr><td class="paramdir">[out]</td><td class="paramname">addr</td><td>: Pointer to the IP information sturcture in which the results to be stored</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>true : if IP address is present </dd>
<dd>
false : otherwise </dd></dl>

</div>
</div>
<a id="gac064ce1afc6b5f07402fdd0bbfb03073" name="gac064ce1afc6b5f07402fdd0bbfb03073"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gac064ce1afc6b5f07402fdd0bbfb03073">&#9670;&nbsp;</a></span>cy_nw_str_to_ipv4()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int cy_nw_str_to_ipv4 </td>
          <td>(</td>
          <td class="paramtype">const char *&#160;</td>
          <td class="paramname"><em>ip_str</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="structcy__nw__ip__address__t.html">cy_nw_ip_address_t</a> *&#160;</td>
          <td class="paramname"><em>address</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Convert IPv4 string to an IP address structure. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">ip_str</td><td>: IPv4 address string. </td></tr>
    <tr><td class="paramdir">[out]</td><td class="paramname">address</td><td>: Pointer to the IP info structure in which the IPv4 address to be stored</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 : if successful </dd>
<dd>
-1 : if failed </dd></dl>

</div>
</div>
<a id="ga8f71bcd9fe077fb6eaad2e6c2794bd7e" name="ga8f71bcd9fe077fb6eaad2e6c2794bd7e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga8f71bcd9fe077fb6eaad2e6c2794bd7e">&#9670;&nbsp;</a></span>cy_nw_ip_register_status_change_callback()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void cy_nw_ip_register_status_change_callback </td>
          <td>(</td>
          <td class="paramtype">cy_nw_ip_interface_t&#160;</td>
          <td class="paramname"><em>iface</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="structcy__nw__ip__status__change__callback__t.html">cy_nw_ip_status_change_callback_t</a> *&#160;</td>
          <td class="paramname"><em>info</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Registers for callback function to be invoked during IP status change. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">iface</td><td>: Pointer to network interface object </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">info</td><td>: Pointer to the status change information structure</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>none </dd></dl>

</div>
</div>
<a id="ga7219dc7312b40ea0d047f4a44dad32a4" name="ga7219dc7312b40ea0d047f4a44dad32a4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga7219dc7312b40ea0d047f4a44dad32a4">&#9670;&nbsp;</a></span>cy_nw_ip_unregister_status_change_callback()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void cy_nw_ip_unregister_status_change_callback </td>
          <td>(</td>
          <td class="paramtype">cy_nw_ip_interface_t&#160;</td>
          <td class="paramname"><em>iface</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="structcy__nw__ip__status__change__callback__t.html">cy_nw_ip_status_change_callback_t</a> *&#160;</td>
          <td class="paramname"><em>info</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Un-registers IP status change callback. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">iface</td><td>: Pointer to network interface object </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">info</td><td>: Pointer to the status change information structure</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>none </dd></dl>

</div>
</div>
<a id="ga6e28295152dd34e6d4474d51b73f2ef6" name="ga6e28295152dd34e6d4474d51b73f2ef6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga6e28295152dd34e6d4474d51b73f2ef6">&#9670;&nbsp;</a></span>cy_nw_host_arp_cache_clear()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int cy_nw_host_arp_cache_clear </td>
          <td>(</td>
          <td class="paramtype">cy_nw_ip_interface_t&#160;</td>
          <td class="paramname"><em>iface</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Clears the ARP cache for the interface NOTE: in LwIP, we need the netif (NetworkInterface) to do things, we can find using wifi interface. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">iface</td><td>: Pointer to network interface object</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 : success 1 : fail </dd></dl>

</div>
</div>
<a id="ga0366c24466017d402f414fda93c992b4" name="ga0366c24466017d402f414fda93c992b4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga0366c24466017d402f414fda93c992b4">&#9670;&nbsp;</a></span>cy_nw_host_arp_cache_get_list()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int cy_nw_host_arp_cache_get_list </td>
          <td>(</td>
          <td class="paramtype">cy_nw_ip_interface_t&#160;</td>
          <td class="paramname"><em>iface</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="structcy__nw__arp__cache__entry__t.html">cy_nw_arp_cache_entry_t</a> *&#160;</td>
          <td class="paramname"><em>list</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">uint32_t&#160;</td>
          <td class="paramname"><em>count</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">uint32_t *&#160;</td>
          <td class="paramname"><em>filled</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Gets the ARP cache list for the interface. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">iface</td><td>: Pointer to network interface object </td></tr>
    <tr><td class="paramdir">[in,out]</td><td class="paramname">list</td><td>: Pointer to <a class="el" href="structcy__nw__arp__cache__entry__t.html">cy_nw_arp_cache_entry_t</a> array </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">count</td><td>: Number of entries in the array passed in <code>list</code> </td></tr>
    <tr><td class="paramdir">[in,out]</td><td class="paramname">filled</td><td>: Pointer to get the number of entries filled in the array pointed by 'list'</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 : success 1 : fail </dd></dl>

</div>
</div>
<a id="ga85585d772b32c42db4c6c9ae82f1c5db" name="ga85585d772b32c42db4c6c9ae82f1c5db"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga85585d772b32c42db4c6c9ae82f1c5db">&#9670;&nbsp;</a></span>cy_nw_host_send_arp_request()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int cy_nw_host_send_arp_request </td>
          <td>(</td>
          <td class="paramtype">cy_nw_ip_interface_t&#160;</td>
          <td class="paramname"><em>iface</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const char *&#160;</td>
          <td class="paramname"><em>ip_string</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Send ARP request NOTE: in LwIP, we need the netif (NetworkInterface) to do things, we can find using wifi interface. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">iface</td><td>: Pointer to network interface object </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">ip_string</td><td>: Pointer to the IPv4 address string (Ex: "192.168.1.1") to which the ARP request to be sent</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 : success 1 : failed to send ARP request </dd></dl>

</div>
</div>
<a id="ga8cec7b3315382e02208ba77a14733d8c" name="ga8cec7b3315382e02208ba77a14733d8c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga8cec7b3315382e02208ba77a14733d8c">&#9670;&nbsp;</a></span>cy_nw_get_time()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">uint32_t cy_nw_get_time </td>
          <td>(</td>
          <td class="paramtype">void&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>GET time in milliseconds. </p>
<dl class="section return"><dt>Returns</dt><dd>time in milliseconds </dd></dl>

</div>
</div>
<a id="ga4a490647cb8388c5c00eff6e90e31f67" name="ga4a490647cb8388c5c00eff6e90e31f67"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga4a490647cb8388c5c00eff6e90e31f67">&#9670;&nbsp;</a></span>cy_nw_aton()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool cy_nw_aton </td>
          <td>(</td>
          <td class="paramtype">const char *&#160;</td>
          <td class="paramname"><em>char_ptr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="structcy__nw__ip__address__t.html">cy_nw_ip_address_t</a> *&#160;</td>
          <td class="paramname"><em>addr</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>GET IPv4 address in decimal notation. </p>
<p >NOTE: dotted-decimal notation example (192.168.0.1)</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">char_ptr</td><td>: Pointer to the string containing the IPv4 address in dotted-decimal format. </td></tr>
    <tr><td class="paramdir">[out]</td><td class="paramname">addr</td><td>: Pointer to the structure containing IPv4 address in decimal format.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 : success 1 : failed </dd></dl>

</div>
</div>
<a id="ga6e1d17b795035ddae44eef8934cd5596" name="ga6e1d17b795035ddae44eef8934cd5596"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga6e1d17b795035ddae44eef8934cd5596">&#9670;&nbsp;</a></span>cy_nw_aton_ipv6()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool cy_nw_aton_ipv6 </td>
          <td>(</td>
          <td class="paramtype">const char *&#160;</td>
          <td class="paramname"><em>char_ptr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="structcy__nw__ip__address__t.html">cy_nw_ip_address_t</a> *&#160;</td>
          <td class="paramname"><em>addr</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>GET IPv6 address in decimal notation. </p>
<p >NOTE: This API does not support shorthand representation of IPv6 address. Input string should be of the format X:X:X:X:X:X:X:X.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">char_ptr</td><td>: Pointer to the string containing the IPv6 address. </td></tr>
    <tr><td class="paramdir">[out]</td><td class="paramname">addr</td><td>: Pointer to the structure containing IPv6 address in decimal format.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 : success 1 : failed </dd></dl>

</div>
</div>
<a id="ga6c674d16fdb3bd66e42907e164f9060b" name="ga6c674d16fdb3bd66e42907e164f9060b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga6c674d16fdb3bd66e42907e164f9060b">&#9670;&nbsp;</a></span>cy_nw_ntoa()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool cy_nw_ntoa </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structcy__nw__ip__address__t.html">cy_nw_ip_address_t</a> *&#160;</td>
          <td class="paramname"><em>addr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">char *&#160;</td>
          <td class="paramname"><em>ip_str</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>GET IPv4 address in string format. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">addr</td><td>: Pointer to IPv4 address structure containing the IPv4 address. </td></tr>
    <tr><td class="paramdir">[out]</td><td class="paramname">ip_str</td><td>: Pointer to the string containing IPv4 address in dotted-decimal notation. ip_str must be 16 bytes long. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 : success 1 : failed </dd></dl>

</div>
</div>
<a id="ga8e1203cce5908ff0dc2fe585097925fc" name="ga8e1203cce5908ff0dc2fe585097925fc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga8e1203cce5908ff0dc2fe585097925fc">&#9670;&nbsp;</a></span>cy_nw_ntoa_ipv6()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool cy_nw_ntoa_ipv6 </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structcy__nw__ip__address__t.html">cy_nw_ip_address_t</a> *&#160;</td>
          <td class="paramname"><em>addr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">char *&#160;</td>
          <td class="paramname"><em>ip_str</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>GET IPv6 address in string format. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">addr</td><td>: Pointer to IPv6 address structure containing the IPv6 address. </td></tr>
    <tr><td class="paramdir">[out]</td><td class="paramname">ip_str</td><td>: Pointer to the string containing IPv6 address. ip_str must 39 bytes long. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 : success 1 : failed </dd></dl>

</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath">
    <ul>
        <li class="footer">
            Generated for <b>Connectivity Middleware Utilities Library</b> by <b>Cypress Semiconductor Corporation</b>.
            All rights reserved.
        </li>
    </ul>
</div>
</body>
</html>
